aa.2- Guide de mise a jour

L’objectif de cette vignette est de présenter à l’utilisateur du package {propre.rpls} une manière de rédiger une publication de l’année N à partir de son projet de publication de l’année N-1.

Propos préliminaires : avantages et inconvénients des deux méthodes de mise à jour présentées

Pour créer une publication relative à un nouveau millésime de RPLS à partir de propre.rpls, il y a plusieurs manières de faire.

La première est de repartir sur un projet de publication vierge, avec la procédure utilisée la dernière fois et présentée dans la vignette Guide de prise en main

Avantages : l’utilisateur/rédacteur de la publication bénéficie de toutes les nouveautés incorporées dans le canevas de la publication.

Inconvénients : l’utilisateur/rédacteur de la publication ne récupère pas la personnalisation de sa publication du millésime précédent, il doit faire des copier-coller dans le nouveau canevas de publication pour la retrouver.

Une seconde manière de faire est de repartir de son projet de l’année précédente pour conserver la personnalisation de tous les fichiers .Rmd et d’y injecter les nouvelles données et les nouvelles instructions.

Avantages : l’utilisateur/rédacteur de la publication récupère toute la personnalisation de sa publication du millésime précédent.

Inconvénients : l’utilisateur/rédacteur de la publication ne récupère pas les nouveautés introduites dans le canavas de publication (fichiers .Rmd), comme par exemple une nouvelle fonction de création de graphique ou les instructions pour créer les exports xlsx : il doit faire des copier-coller dans le nouveau canevas de publication pour les ajouter. Il bénéficie pour cela d’une liste des nouvelles fonctionnalités sur le site de présentation du package, et du modele de canevas vierge sur le dépôt.

En conclusion, il n’y a pas de méthode magique, pour décider quelle méthode de mise à jour privilégier, il faut mettre en balance le niveau de personnalisation de votre book (vos fichiers rmd) avec le nombre de modifications apportées au canevas par l’équipe propre.rpls chaque année.

Comment générer la publication N à partir de la publication N-1 ?

1. Créez un projet R dédié au nouveau millésime de la publication (millésime N)

Si vous n’utilisez pas git pour travailler sur votre publication, créez une copie de votre projet de publication de l’année dernière (le dossier bureautique contenant les fichiers .Rmd de l’année dernière). Renommez-le en ajoutant par exemple le millesime, vous conserverez ainsi intact le dossier de l’année passée.

Si votre projet R de publication portant sur le millésime N-1 est versionné avec git, créez une nouvelle branche dédiée au nouveau millésime. Cette branche deviendra votre branche principale de travail.

Dans les deux cas, supprimez les fichiers RData de votre nouveau projet (fichiers fond_carto.RData et indicateurs_rpls.RData) pour y forcer le calcul des indicateurs.

2. Mettez à jour le package {propre.rpls}

Le package propre.rpls est à mettre à jour au moins une fois chaque année, pour disposer du nouveau millésime des données. L’équipe responsable de l’outil informe le RDES de sa livraison chaque année, et indique le n° de version avec lequel il faut désormais travailler.

Pour connaître la version de propre.rpls installée sur votre PC, vérifiez dans la fenêtre RStudio en bas à droite –> Onglet Packages –> colonne ‘Version’

Si besoin vous pouvez vérifier dans gitlab, la dernière version du package. En effet, Gitlab vous indique au niveau de la page ‘releases’ quelles sont les différentes versions de {propre.rpls}.

Si la version installée ne correspond pas à la dernière version disponible, vous devez mettre à jour le package avec la commande ci-dessous exactement comme pour une installation :

# install.packages("remotes") # au cas où le package {remotes} ne serait pas déjà installé
remotes::install_gitlab("rdes_dreal/propre.rpls")

3. Faites évoluer votre book

Votre book, ou votre publication, est constitué.e d’un ensemble de fichiers .Rmd disposés à la racine de votre projet R. La plupart des fichiers .Rmd correspondent à un chapitre de la publication. Le fichier index.Rmd est le pilote des fichiers par chapitre, c’est en quelque sorte l’en-tête de votre publication.

Augmentez d’un an le paramètre ‘annee’

Le fichier index.Rmd comprend notamment les paramètres de personnalisation de votre publication, comme la région, le niveau de détails souhaité pour les EPCI, mais également le millésime.

En modifiant le paramètre annee de N-1 à N dans ce fichier index.Rmd, vous modifierez les valeurs, titres et verbatims calculés dans l’ensemble de la publication.

Pour ce faire, rdv à la ligne 10 du fichier index.Rmd et incrémentez l’année de N-1 à N :

Recalculer les indicateurs et les fonds de cartes

Si vous avez aviez supprimé du projet vos anciens fichiers indicateurs_rpls.RData et fond_carto.RData, l’étape qui suit est facultative.

Comme indiqué au niveau de la vignette Préparation des données, cette étape de mise au COG et de calcul des indicateurs est assez lourde. Aussi ses résultats sont sauvegardés au format RData sur le disque dur de l’utilisateur pour lui éviter de perdre du temps à refaire les mêmes calculs encore et encore. Si ces résultats datent de l’année dernière, ils ne contiennent pas les valeurs du nouveau millésime, votre book nouveau millésime ne pourra donc pas être recalculé à l’aide de ces derniers.

Pour forcer le re-calcul des indicateurs visualisés dans les tableaux, cartes, graphiques… suite à un changement de paramètre de la publication, il faut procéder de la même manière que lors d’un changement du niveau de détail par EPCI.

C’est à dire qu’il faut, dans le fichier index.Rmd, trouver la ligne où la fonction get_dataprep() calcule l’objet indicateurs_rpls et modifier la valeur du paramètre maj en le mettant à TRUE. Dans l’exemple ci dessus, ça se passe ligne 57.

Il est également conseillé de recalculer les fonds de cartes, car les EPCI changent parfois de contours d’une année sur l’autre. Pour cela, dans le fichier index.Rmd, il vous faut trouver la ligne où la fonction get_fond_carto() calcule l’objet fond_carto (ligne 68 dans l’exemple ci dessus) et modifier la valeur du paramètre maj en le mettant à TRUE.

Recalculer les indicateurs de l’application de consultation des indicateurs complémentaires

Enfin, les données de l’application run_rpls_explorer sont également mises en cache sur le poste de l’utilisateur. Pour les mettre à jour, il faut lancer le module d’exploration des données avec l’instruction :

run_rpls_explorer(nom_reg = params$nom_region, mil = params$annee, clean = TRUE)

Le paramètre clean peut être remis à FALSE la prochaine fois pour bénéficier des résultats mis en cache.

Ajouter aux différents fichiers .Rmd les nouveautés de l’année

Chaque année l’équipe responsable du produit {propre.rpls} apporte des nouveautés au canevas de la publication. Par exemple, en 2023 un nouveau graphique a été demandé dans le chapitre 5 sur l’évolution de la vacance et du taux de mobilité. Cela aboutit à l’ajout de quelques lignes à la fin du fichier 05-tensions.Rmd

'''{r mobilite et tension, message=FALSE, warning=FALSE}
graphe_5_1 <- creer_graphe_5_1(data = indicateurs_rpls_ref, annee = annee)
exports_xls <- incrementer_export_xls(graphe_5_1, list_xls = exports_xls)
afficher_visuel(graphe_5_1)
'''

Dans le cas où vous mettez à jour votre publication de l’année dernière, il vous faut donc faire des copier-coller dans le nouveau canevas de publication pour ajouter ces nouveautés.

Pour identifier ces nouveautés, vous pouvez consulter la liste des nouvelles fonctionnalités sur le site de présentation du package, ou comparer votre book au canevas vierge de la publication sur le dépôt gitlab..